<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\library\Model</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Creates records an instance of the PDO Abstraction class chain."><span class="description">Creates records an instance of the PDO Abstraction class chain.</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#delete" title="delete :: Sends a DELETE query to the PDO object."><span class="description">Sends a DELETE query to the PDO object.</span><pre>delete()</pre></a></li>
<li class="method public "><a href="#get" title="get :: Sends a SELECT query to the PDO object."><span class="description">Sends a SELECT query to the PDO object.</span><pre>get()</pre></a></li>
<li class="method public "><a href="#insert" title="insert :: Sends an INSERT query to the PDO object."><span class="description">Sends an INSERT query to the PDO object.</span><pre>insert()</pre></a></li>
<li class="method public "><a href="#query" title="query :: Generic PDO Query method."><span class="description">Generic PDO Query method.</span><pre>query()</pre></a></li>
<li class="method public "><a href="#save" title="save :: Sends an INSERT query to the PDO object."><span class="description">Sends an INSERT query to the PDO object.</span><pre>save()</pre></a></li>
<li class="method public "><a href="#select" title="select :: Sends a SELECT query to the PDO object."><span class="description">Sends a SELECT query to the PDO object.</span><pre>select()</pre></a></li>
<li class="method public "><a href="#selectCols" title="selectCols :: Sends a SELECT query to the PDO object."><span class="description">Sends a SELECT query to the PDO object.</span><pre>selectCols()</pre></a></li>
<li class="method public "><a href="#set" title="set :: Sends an INSERT query to the PDO object."><span class="description">Sends an INSERT query to the PDO object.</span><pre>set()</pre></a></li>
<li class="method public "><a href="#setOrder" title="setOrder :: Sets the Column and Direction for sort operations."><span class="description">Sets the Column and Direction for sort operations.</span><pre>setOrder()</pre></a></li>
<li class="method public "><a href="#update" title="update :: SQL UPDATE Abstraction"><span class="description">SQL UPDATE Abstraction</span><pre>update()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24db" title="$db :: Holds instance of the PDO Abstraction class chain"><span class="description">Holds instance of the PDO Abstraction class chain</span><pre>$db</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24order_by_col" title="$order_by_col :: Holds Column name for sorting operations"><span class="description">Holds Column name for sorting operations</span><pre>$order_by_col</pre></a></li>
<li class="property private "><a href="#%24order_direction" title="$order_direction :: Holds sorting direction (ASC, DESC) for sorting operations"><span class="description">Holds sorting direction (ASC, DESC) for sorting operations</span><pre>$order_direction</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5Clibrary%5CModel" id="\framework\library\Model"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.html">library</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.library.Model.html">Model</a>
</li>
</ul>
<div href="../classes/framework.library.Model.html" class="element class">
<p class="short_description">Model Class</p>
<div class="details">
<p class="long_description"><p>Plurious Core</p>

<p>Base Model implementing Simple PDO Abstraction classes</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\database\DB</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\model\Not_Found</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\model\User_Admin_Model</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\model\Home</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\authentication\Auth</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Creates records an instance of the PDO Abstraction class chain.</h2>
<pre>__construct($name, $user, $pw, $type, $host, $port) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$user</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$pw</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$type</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$host</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$port</h4>
<code></code>
</div>
</div></div>
</div>
<a name="delete" id="delete"></a><div class="element clickable method public delete" data-toggle="collapse" data-target=".delete .collapse">
<h2>Sends a DELETE query to the PDO object.</h2>
<pre>delete(\framework\library\type $table, array $where) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Passes query to PDO Abstraction Class DELETE Method</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>\framework\library\type</code><p>The Table name to delete rows from</p></div>
<div class="subelement argument">
<h4>$where</h4>
<code>array</code><p>The WHERE clause (cannot be empty)</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>Number of deleted rows</div>
</div></div>
</div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
<h2>Sends a SELECT query to the PDO object.</h2>
<pre>get(string $table, array $where, int $limit) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This query is synonymous with the select() method.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>The Table to query</p></div>
<div class="subelement argument">
<h4>$where</h4>
<code>array</code><p>The WHERE clause equivilance</p></div>
<div class="subelement argument">
<h4>$limit</h4>
<code>int</code><p>The return limit</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Associative array of DB results</div>
</div></div>
</div>
<a name="insert" id="insert"></a><div class="element clickable method public insert" data-toggle="collapse" data-target=".insert .collapse">
<h2>Sends an INSERT query to the PDO object.</h2>
<pre>insert(string $table, array $data) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This method is synonymous with set() &amp; save() methods</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>Table to insert into</p></div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code><p>Data to insert</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>ID of inserted row</div>
</div></div>
</div>
<a name="query" id="query"></a><div class="element clickable method public query" data-toggle="collapse" data-target=".query .collapse">
<h2>Generic PDO Query method.</h2>
<pre>query(string $sql, array $data) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>User must supply complete SQL statement.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sql</h4>
<code>string</code><p>The SQL statement to execute</p></div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code><p>The data for the query</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>Array if SELECT, otherwise affected rows</div>
</div></div>
</div>
<a name="save" id="save"></a><div class="element clickable method public save" data-toggle="collapse" data-target=".save .collapse">
<h2>Sends an INSERT query to the PDO object.</h2>
<pre>save(string $table, array $data) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This method is synonymous with insert() method</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>Table to insert into</p></div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code><p>Data to insert</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>ID of inserted row</div>
</div></div>
</div>
<a name="select" id="select"></a><div class="element clickable method public select" data-toggle="collapse" data-target=".select .collapse">
<h2>Sends a SELECT query to the PDO object.</h2>
<pre>select(string $table, array $where, int $limit) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This query is synonymous with the select() method.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>The Table to query</p></div>
<div class="subelement argument">
<h4>$where</h4>
<code>array</code><p>The WHERE clause equivilance</p></div>
<div class="subelement argument">
<h4>$limit</h4>
<code>int</code><p>The return limit</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Associative array of DB results</div>
</div></div>
</div>
<a name="selectCols" id="selectCols"></a><div class="element clickable method public selectCols" data-toggle="collapse" data-target=".selectCols .collapse">
<h2>Sends a SELECT query to the PDO object.</h2>
<pre>selectCols(string $table, array $cols, array $where, int $limit) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This query is synonymous with the select() method.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>The Table to query</p></div>
<div class="subelement argument">
<h4>$cols</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$where</h4>
<code>array</code><p>The WHERE clause equivilance</p></div>
<div class="subelement argument">
<h4>$limit</h4>
<code>int</code><p>The return limit</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Associative array of DB results</div>
</div></div>
</div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
<h2>Sends an INSERT query to the PDO object.</h2>
<pre>set(string $table, array $data) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This method is synonymous with insert() method</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>Table to insert into</p></div>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code><p>Data to insert</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>ID of inserted row</div>
</div></div>
</div>
<a name="setOrder" id="setOrder"></a><div class="element clickable method public setOrder" data-toggle="collapse" data-target=".setOrder .collapse">
<h2>Sets the Column and Direction for sort operations.</h2>
<pre>setOrder(string $col, string $dir) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>NOTE: you must reset these parameters when finished with them. Otherwise
all results following will be sorted using these criteria.</p>

<p>To clear the sort criteria simply call this method with
no parameters passed -- setOrder();</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$col</h4>
<code>string</code><p>The name of the column to sort results on</p></div>
<div class="subelement argument">
<h4>$dir</h4>
<code>string</code><p>Should be ASC or DESC</p></div>
</div></div>
</div>
<a name="update" id="update"></a><div class="element clickable method public update" data-toggle="collapse" data-target=".update .collapse">
<h2>SQL UPDATE Abstraction</h2>
<pre>update(array $new_values, string $table, array $where) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Passes query to PDO Abstraction Class UPDATE Method</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$new_values</h4>
<code>array</code><p>The data used for the update</p></div>
<div class="subelement argument">
<h4>$table</h4>
<code>string</code><p>Name of the table to query</p></div>
<div class="subelement argument">
<h4>$where</h4>
<code>array</code><p>The WHERE clause</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>Number of affected rows</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24db" id="$db"> </a><div class="element clickable property protected $db" data-toggle="collapse" data-target=".$db .collapse">
<h2>Holds instance of the PDO Abstraction class chain</h2>
<pre>$db </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24order_by_col" id="$order_by_col"> </a><div class="element clickable property private $order_by_col" data-toggle="collapse" data-target=".$order_by_col .collapse">
<h2>Holds Column name for sorting operations</h2>
<pre>$order_by_col </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24order_direction" id="$order_direction"> </a><div class="element clickable property private $order_direction" data-toggle="collapse" data-target=".$order_direction .collapse">
<h2>Holds sorting direction (ASC, DESC) for sorting operations</h2>
<pre>$order_direction </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:44-05:00.<br></footer></div>
</div>
</body>
</html>
